.. _`Grid Parameter Search`:

.. _`org.sysess.sympathy.machinelearning.grid_parsearch`:

Grid Parameter Search
`````````````````````

.. image:: hyperparam.svg
   :width: 48


Exhaustive search over hyperparameters.




Documentation
:::::::::::::

Evaluates each parameter combination in the set of parameter hypercubes given by each
table in the list of parameter tables. Each parameter table specify a hypercube of dimension
N where N is the number of columns in the table. Every combination of parameter values in
each such cube will be sampled.


Definition
::::::::::


Input ports
...........

    **in-model**
        | Type: model
        | Description: in-model
    **parameter space**
        | Type: [table]
        | Description: param-space
    **X**
        | Type: table
        | Description: X
    **Y**
        | Type: table
        | Description: Y
    **cross-validation**
        | Type: [(table,table)]
        | Description: cross-validation
        | Optional number of ports: 0--1 (default: 0)
        

Output ports
............

    **results**
        | Type: table
        | Description: results
    **parameters**
        | Type: table
        | Description: parameters
    **out-model**
        | Type: model
        | Description: out-model



Configuration
.............

    **Cross validation splits** (cv)
        Number of fold in the default K-Fold cross validation. Ignored when cross-validation port is given







Examples
........





The node can be found in:

* :download:`Hyper_parameters.syx </Examples/Sympathy for Data/MachineLearning/Hyper_parameters.syx>`

* :download:`MNIST_Digits.syx </Examples/Sympathy for Data/MachineLearning/MNIST_Digits.syx>`




Implementation
..............

.. automodule:: node_paramsearch
    :noindex:

.. class:: ParameterSearch_Grid
    :noindex: